PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

keyvaluestore_keyvalues

Retrieves a keyvaluestore_keyvalues resource.

Retrieves a keyvaluestore_keyvalues resource.

Authorizations:
JWT
path Parameters
id
required
string

keyvaluestore_keyvalues identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shortcode": "KVS",
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": {
    },
  • "corporation": {
    },
  • "notes": "string",
  • "clearanceLevel": 7,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "fieldFromKey": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the keyvaluestore_keyvalues resource.

Replaces the keyvaluestore_keyvalues resource.

Authorizations:
JWT
path Parameters
id
required
string

keyvaluestore_keyvalues identifier

Request Body schema:
required

The updated keyvaluestore_keyvalues resource

key
string >= 2 characters
value
string
description
string or null
users.jsonld-post (object) or null
person_corporations.jsonld-post (object) or null
notes
string or null
clearanceLevel
integer
Default: 7

0 secret 1 super-admin 2 admin 3 super user 4 manager 5 sub manager 6 user 7 limiter user 8 almost general 9 general 10 public

https://github.com/PHPCreation/phpr_erp/issues/3316

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": {
    },
  • "corporation": {
    },
  • "notes": "string",
  • "clearanceLevel": 7,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "shortcode": "KVS",
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "user": {
    },
  • "corporation": {
    },
  • "notes": "string",
  • "clearanceLevel": 7,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "fieldFromKey": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the keyvaluestore_keyvalues resource.

Removes the keyvaluestore_keyvalues resource.

Authorizations:
JWT
path Parameters
id
required
string

keyvaluestore_keyvalues identifier

Responses